DOC: Fixed PR08 and PR09 docstring errors in pandas.Series #28845
Conversation
| @@ -2276,31 +2276,30 @@ def to_json( | |||
| orient : str | |||
| Indication of expected JSON string format. | |||
|
|
|||
| * Series | |||
| * Series: | |||
|
|
|||
There was a problem hiding this comment.
@datapythonista do we want the blank lines on 2280, 2283, 2285, ...?
There was a problem hiding this comment.
Not sure if we have a convention for that, but I don't think so. I think it'll be more readable without them, and markdown requires them for some implementations, but I don't think rst does.
There was a problem hiding this comment.
Great job, added few comments.
Note that the first line of Returns is the type (they look like description, but they shouldn't be). So, no period at the end should be added. See: https://dev.pandas.io/docs/development/contributing_docstring.html#section-4-returns-or-yields
| @@ -2276,31 +2276,30 @@ def to_json( | |||
| orient : str | |||
| Indication of expected JSON string format. | |||
|
|
|||
| * Series | |||
| * Series: | |||
|
|
|||
There was a problem hiding this comment.
Not sure if we have a convention for that, but I don't think so. I think it'll be more readable without them, and markdown requires them for some implementations, but I don't think rst does.
| how : {'start', 'end'}, default end | ||
| For PeriodIndex only, see PeriodIndex.asfreq | ||
| For PeriodIndex only (see PeriodIndex.asfreq). |
There was a problem hiding this comment.
Using next should make it a link I think:
:meth:`PeriodIndex.asfreq`
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
Co-Authored-By: Marc Garcia <[email protected]>
|
Thanks a lot for the fixes @jackbicknell14 |
Fixed all PR08 and PR09 issues in pandas.Series.
black pandas